You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
P1 — Dashboard JSON URL 404 (opentelemetry-collector-dashboard.mdx:23)
The dashboardJsonUrl points to SigNoz/dashboards/opentelemetry-collector/opentelemetry-collector.json, which does not exist in the SigNoz/dashboards repo. The "Import Dashboard" button will break for users. A companion PR to that repo is needed before merging.
P2 — Meta description too long (opentelemetry-collector-metrics.mdx:5)
At 192 characters, the metrics doc description exceeds the 120–160 character guideline. Suggested trim in the inline comment.
P3 — Dashboard title 1 char under minimum (opentelemetry-collector-dashboard.mdx:5)
Title is 49 characters vs. the 50-character minimum. Minor — suggestion in inline comment.
P3 — Inconsistent trailing period (opentelemetry-collector-metrics.mdx:172)
Third "Next Steps" bullet is missing the . that the other two have.
Primary job: "When my Collector pipelines handle production traffic, I want to monitor their internal health, so I can catch drops, queue pressure, and resource issues before they impact data delivery."
The metrics doc covers a clean happy path: configure telemetry reader → restart → validate in Metrics Explorer. VM / Docker / Kubernetes tabs are well-structured.
The dashboard doc follows the template pattern: prerequisite link, screenshot, DashboardActions, metric descriptions, and related dashboards.
✅ service.telemetry.metrics.readers with periodic OTLP exporter is correct per OTel docs; interval: 60000 (ms) is correct; level descriptions accurate
Open Questions
The dashboard JSON needs to exist in SigNoz/dashboards before merge — is there a companion PR for that?
Onboarding Label
Onboarding label: applied — opentelemetry-collector-metrics.mdx is a new doc whose primary job is sending Collector internal metrics to SigNoz, with concrete ingestion setup (endpoint + key). The dashboard template page does not qualify per policy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
📄 Summary
This PR adds OpenTelemetry internal metrics doc and dashboard template page.
Part of: SigNoz/dashboards#379
Doc Links: